Android SDK

Añade AR Clip VPS a una app nativa de Android. El SDK encuentra la posición del usuario en tus mapas VPS en dispositivos con ARCore, e incluye fragments de Sceneform y utilidades para el ciclo de vida.

Antes de empezar

• Android SDK 24 (Android 7.0) o posterior
• Un dispositivo compatible con ARCore
• Un proyecto en Kotlin (los ejemplos están en Kotlin)

¿Necesitas una clave de API?

Consíguela en arclip.design o escribe a support@arclip.design.

Instalación

1. Asegúrate de que el proyecto descarga artefactos de Maven Central:

   allprojects {
       repositories {
           mavenCentral()
           // other repositories...
       }
   }

2. Añade la dependencia al módulo de tu app:

   dependencies {
       implementation "com.arstudio:wasvps-sdk:1.0.0"
   }

3. Sincroniza Gradle.

Configurar el manifiesto

Declara que la app necesita ARCore. Si el minSdk de tu propia app es menor que 24, añade también la sobrescritura uses-sdk; si no, la compilación falla. El SDK en sí sigue necesitando Android 7.0 (API 24) o posterior.

<!-- Only if your app's minSdk is below 24 -->
<uses-sdk tools:overrideLibrary="com.arstudio.wasvps_sdk, com.google.ar.sceneform.sceneform, com.google.ar.sceneform.ux" />

<!-- Restrict to ARCore hardware (default). Set required=false to broaden install base. -->
<uses-feature
    android:name="android.hardware.camera.ar"
    android:required="true" />

Para que la app se muestre a más dispositivos en Play Store, pon android:required="false" y añade tools:replace="android:required", para que tu valor sustituya al del SDK:

<uses-feature
    android:name="android.hardware.camera.ar"
    android:required="false"
    tools:replace="android:required" />

Inicio rápido con WASVPSArFragment

Añade a tu layout el fragment incluido:

<!-- res/layout/activity_main.xml -->
<androidx.fragment.app.FragmentContainerView
    android:id="@+id/vFragmentContainer"
    android:name="com.arstudio.wasvps_sdk.ui.WASVPSArFragment"
    android:layout_width="match_parent"
    android:layout_height="match_parent" />

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        supportFragmentManager.beginTransaction()
            .replace(R.id.vFragmentContainer, WASVPSArFragment())
            .commit()
    }
}

Cuando tengas los ID de ubicación, obtén el servicio e inicia la localización:

val fragment = supportFragmentManager
    .findFragmentById(R.id.vFragmentContainer) as WASVPSArFragment

val config = WASVPSConfig.getIndoorConfig(listOf("your-location-id"))
val service = fragment.vpsService

service.setVpsConfig(config)
service.setVpsCallback(object : VpsCallback {
    override fun onSuccess() = Unit
    override fun onFail() = Unit
    override fun onStateChange(state: State) = Unit
    override fun onError(error: Throwable) {
        Log.e("VPS", "Localization error", error)
    }
})

service.startVpsService()

Llama a service.stopVpsService() cuando la experiencia AR deba pausarse, por ejemplo en onPause.

Usar tu propio fragment

Si tienes tu propio ArFragment o ArSceneView, crea y gestiona WASVPSService tú mismo:

class CustomArFragment : ArFragment() {
    private val vpsService = WASVPSService.newInstance()

    override fun onAttach(context: Context) {
        super.onAttach(context)
        WASVPSSdk.init(context.applicationContext)
    }

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        vpsService.bindArSceneView(arSceneView)
        vpsService.setVpsConfig(WASVPSConfig.getOutdoorConfig(listOf("location-id")))
    }

    override fun onResume() {
        super.onResume()
        vpsService.resume()
        vpsService.startVpsService()
    }

    override fun onPause() {
        vpsService.pause()
        vpsService.stopVpsService()
        super.onPause()
    }

    override fun onDestroyView() {
        vpsService.destroy()
        super.onDestroyView()
    }
}

Colocar contenido

Añade nodos como hijos de vpsService.worldNode. En cuanto VPS consigue localizarte, todos los hijos siguen la posición global localizada.

val anchorNode = Node().apply {
    setParent(vpsService.worldNode)
    localPosition = Vector3(0f, 0f, -1f)
}

Solución de problemas

• Comprueba que Google Play Services para AR está instalado y actualizado en el dispositivo de prueba.
• Si la localización no funciona nunca, revisa la clave de API que le pasas al SDK (mediante una configuración segura) y comprueba que tus ID de ubicación existen.
• En el módulo /sample del repositorio tienes un ejemplo completo, con permisos en tiempo de ejecución e interfaz.